String Procedures

Include file: AfxStr.inc

AfxStrClipLeft

Returns a string with nCount characters removed from the left side of the string.

FUNCTION AfxStrClipLeft (BYREF wszMainStr AS CONST WSTRING, BYVAL nCount AS LONG) AS CWSTR

AfxStrClipMid

Returns a string with nCount characters removed from the left side of the string.

FUNCTION AfxStrClipMid (BYREF wszMainStr AS CONST WSTRING, BYVAL nStart AS LONG, BYVAL nCount AS LONG) AS CWSTR

AfxStrClipRight

Returns a string with nCount characters removed from the right side of the string.

FUNCTION AfxStrClipRight  (BYREF wszMainStr AS CONST WSTRING, BYVAL nCount AS LONG) AS CWSTR

AfxStrCSet

Returns a string containing a centered string.

FUNCTION AfxStrCSet (BYREF wszMainStr AS CONST WSTRING, _
   BYVAL nStringLength AS LONG, BYREF wszPadCharacter AS CONST WSTRING = " ") AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrCSet("FreeBasic", 20, "*")

AfxStrDelete

Deletes a specified number of characters from a string expression.

FUNCTION AfxStrDelete (BYREF wszMainStr AS CONST WSTRING, _
   BYVAL nStart AS LONG, BYVAL nCount AS LONG) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrDelete("1234567890", 4, 3)   ' Returns 1234890"

AfxStrExtract

Extracts characters from a string up to (but not including) a string. Case sensitive.

FUNCTION AfxStrExtract (BYVAL nStart AS LONG, _
   BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszMatchStr AS CONST WSTRING) AS CWSTR

Usage example

The following line returns "aba" (match on "cad")
DIM cws AS CWSTR = AfxStrExtract(1, "abacadabra","cad")

AfxStrExtract (Overload)

FUNCTION AfxStrExtract (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszDelim1 AS WSTRING, BYREF wszDelim2 AS WSTRING) AS CWSTR

Extracts the portion of a string following the occurrence of a specified delimiter up to the second delimiter. If one or both of the delimiters aren't found, it returns an empty string.

Usage example

The following lines return "text between parentheses" (text delimited by "(" and ")")
DIM cws AS CWSTR = "blah blah (text beween parentheses) blah blah"
PRINT AfxStrExtract(cws, "(", ")")

AfxStrExtract (Overload)

FUNCTION AfxStrExtract (BYVAL nStart AS LONG, BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszDelim1 AS WSTRING, BYREF wszDelim2 AS WSTRING) AS CWSTR

AfxStrExtractI

Extracts characters from a string up to (but not including) a string. Case insensitive.

FUNCTION AfxStrExtractI (BYVAL nStart AS LONG, _
   BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszMatchStr AS CONST WSTRING) AS CWSTR

Usage example

The following line returns "aba" (match on "CaD")
DIM cws AS CWSTR = AfxStrExtractI(1, "abacadabra","CaD")

AfxStrExtractAny

Extracts characters from a string up to (but not including) a group of characters. Case sensitive.

FUNCTION AfxStrExtractAny (BYVAL nStart AS LONG, _
   BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszMatchStr AS CONST WSTRING) AS CWSTR

Usage example

The following line returns "aba" (match on "c")
DIM cws AS CWSTR = AfxStrExtractAny(1, "abacadabra","cd")

AfxStrExtractAnyI

Extracts characters from a string up to (but not including) a group of characters. Case insensitive.

FUNCTION AfxStrExtractAnyI (BYVAL nStart AS LONG, _
   BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszMatchStr AS CONST WSTRING) AS CWSTR

Usage example

The following line returns "aba" (match on "c")
DIM cws AS CWSTR = AfxStrExtractAnyI(1, "abacadabra","Cd")

AfxStrFormatByteSize

Converts a numeric value into a string that represents the number expressed as a size value in bytes, kilobytes, megabytes, or gigabytes, depending on the size.

FUNCTION AfxStrFormatByteSize (BYVAL ull AS ULONGLONG) AS CWSTR

AfxStrFormatKBSize

Converts a numeric value into a string that represents the number expressed as a size value in kilobytes.

FUNCTION AfxStrFormatKBSize (BYVAL ull AS ULONGLONG) AS CWSTR

AfxStrFromTimeInterval

Converts a time interval, specified in milliseconds, to a string.

FUNCTION AfxStrFromTimeInterval (BYVAL dwTimeMS AS DWORD, BYVAL digits AS LONG) AS CWSTR

Some examples for digits:

AfxStrInsert

Inserts a string at a specified position within another string expression.

FUNCTION AfxStrInsert (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszInsertString AS CONST WSTRING, BYVAL nPosition AS LONG) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrInsert("1234567890", "--", 6)   ' Returns "123456--7890"

AfxStrJoin

Returns a string consisting of all of the strings in an array, each separated by a delimiter. If the delimiter is a null (zero-length) string then no separators are inserted between the string sections. If the delimiter expression is the 3-byte value of "," which may be expressed in your source code as the string literal """,""" or as Chr(34,44,34) then a leading and trailing double-quote is added to each string section. This ensures that the returned string contains standard comma-delimited quoted fields that can be easily parsed.

FUNCTION AfxStrJoin (BYREF cwsa AS CSafeArray, BYREF wszDelimiter AS WSTRING = " ") AS CWSTR

Return value

A CWSTR containing the joined string.

Usage example

DIM csa AS CSafeArray = CSafeArray("STRING", 3, 1)
csa.PutStr(1, "One")
csa.PutStr(2, "Two")
csa.PutStr(3, "Three")
DIM cws AS CWSTR = AfxStrJoin(csa, ",")
PRINT cws   ' ouput: One,Two,Three

Include file: CSafeArray.inc

AfxStrLCase

Returns a lowercased version of a string.

FUNCTION AfxStrLCase (BYVAL pwszStr AS WSTRING PTR, _
   BYVAL pwszLocaleName AS WSTRING PTR = LOCALE_NAME_USER_DEFAULT, _
   BYVAL dwMapFlags AS DWORD = 0) AS CWSTR

For a table of language culture names see: Table of Language Culture Names, Codes, and ISO Values

For a complete list see: LCMapStringEx function

Remarks

The string conversion functions available in FreeBasic are not fully suitable for some languages. For example, the Turkish word "karışıklığı" is uppercased as "KARıŞıKLıĞı" instead of "KARIŞIKLIĞI", and "KARIŞIKLIĞI" is lowercased to "karişikliği" instead of "karışıklığı". Notice the "ı", that is not an "i".

Return value

The lowercased string.

AfxStrLSet

Returns a string containing a left justified string.

FUNCTION AfxStrLSet (BYREF wszMainStr AS CONST WSTRING, _
   BYVAL nStringLength AS LONG, BYREF wszPadCharacter AS CONST WSTRING = " ") AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrLSet("FreeBasic", 20, "*")

AfxStrParse

Returns a delimited field from a string expression.

FUNCTION AfxStrParse (BYREF wszMainStr AS CONST WSTRING, _
   BYVAL nPosition AS LONG = 1, BYREF wszDelimiter AS CONST WSTRING = ",") AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrParse("one,two,three", 2)   ' Returns "two"
DIM cws AS CWSTR = AfxStrParse("one;two,three", 1, ";")   ' Returns "one"

AfxStrParseAny

Returns a delimited field from a string expression.

FUNCTION AfxStrParse (BYREF wszMainStr AS CONST WSTRING, _
   BYVAL nPosition AS LONG = 1, BYREF wszDelimiter AS CONST WSTRING = ",") AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrParseAny("1;2,3", 2, ",;")   ' Returns "2"

AfxStrParseCount

Returns the count of delimited fields from a string expression.

FUNCTION AfxStrParseCount (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszDelimiter AS CONST WSTRING = ",") AS LONG

Usage example

DIM nCount AS LONG = AfxStrParseCount("one,two,three", ",")   ' Returns 3

AfxStrParseCountAny

Returns the count of delimited fields from a string expression.

FUNCTION AfxStrParseCountAny (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszDelimiter AS CONST WSTRING = ",") AS LONG

Usage example

DIM nCount AS LONG = AfxStrParseCountAny("1;2,3", ",;")   ' Returns 3

AfxStrPathName

Parses a path to extract component parts.

FUNCTION AfxStrPathName (BYREF wszOption AS CONST WSTRING, BYREF wszFileSpec AS WSTRING) AS CWSTR

AfxStrRemain

Returns the portion of a string following the first occurrence of a string. Case sensitive.

FUNCTION AfxStrRemain (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszMatchStr AS CONST WSTRING, BYVAL nStart AS LONG = 1) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrRemain("Brevity is the soul of wit", "is ")   ' Returns "the soul of wit"

AfxStrRemainI

Returns the portion of a string following the first occurrence of a string. Case insensitive.

FUNCTION AfxStrRemainI (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszMatchStr AS CONST WSTRING, BYVAL nStart AS LONG = 1) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrRemain("Brevity is the soul of wit", "Is ")   ' Returns "the soul of wit"

AfxStrRemainAny

Returns the portion of a string following the first occurrence of a list of characters. Case sensitive.

FUNCTION AfxStrRemainAny (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszMatchStr AS CONST WSTRING, BYVAL nStart AS LONG = 1) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrRemainAny("I think, therefore I am", ",")   ' Returns "therefore I am"

AfxStrRemainAnyI

Returns the portion of a string following the first occurrence of a list of characters. Case insensitive.

FUNCTION AfxStrRemainAnyI (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszMatchStr AS CONST WSTRING, BYVAL nStart AS LONG = 1) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrRemainAnyI("I think, therefore I am", "E")   ' -> "refore I am"

AfxStrRemove

Returns a new string with strings removed. Case sensitive.

FUNCTION AfxStrRemove (BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrRemove("Hello World. Welcome to the Freebasic World", "World")

AfxStrRemove (Overload)

Returns a copy of a string with a substring enclosed between the specified delimiters removed. Case sensitive.

FUNCTION AfxStrRemove (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszDelim1 AS CONST WSTRING, BYREF wszDelim2 AS CONST WSTRING, _
   BYVAL fRemoveAll AS BOOLEAN = FALSE) AS CWSTR

Usage examples

DIM cwsText AS CWSTR = "blah blah (text beween parentheses) blah blah"
DIM cws AS CWSTR = AfxStrRemove(cwsText, "(", ")")   ' Returns "blah blah  blah blah"

DIM cwsText AS CWSTR = "As Long var1(34), var2(  73 ), var3(any)"
DIM cws AS CWSTR = AfxStrRemove(cwsText, "(", ")", TRUE)   ' Returns "As Long var1, var2, var3"

AfxStrRemove (Overload)

Returns a copy of a string with a substring enclosed between the specified delimiters removed. Case sensitive.

FUNCTION AfxStrRemove (BYVAL nSart AS LONG = 1, BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszDelim1 AS CONST WSTRING, BYREF wszDelim2 AS CONST WSTRING, _
   BYVAL fRemoveAll AS BOOLEAN = FALSE) AS CWSTR

Usage examples

DIM cwsText AS CWSTR = "blah blah (text beween parentheses) blah blah"
DIM cws AS CWSTR = AfxStrRemove(cwsText, "(", ")")   ' Returns "blah blah  blah blah"

AfxStrRemoveI

Returns a new string with strings removed. Case insensitive.

FUNCTION AfxStrRemoveI (BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS CWSTR

Usage example

AfxStrRemoveI("Hello World. Welcome to the Freebasic World", "world")

AfxStrRemoveAny

Returns a new string with characters removed. Case sensitive.

FUNCTION AfxStrRemoveAny (BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrRemoveAny("abacadabra", "bac")   ' -> "dr"

AfxStrRemoveAnyI

Returns a new string with characters removed. Case insensitive.

FUNCTION AfxStrRemoveAnyI (BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrRemoveAnyI("abacadabra", "BaC")   ' -> "dr"

AfxStrRepeat

Returns a string consisting of multiple copies of the specified string. This function is similar to STRING, but STRING only makes multiple copies of a single character.

FUNCTION AfxStrRepeat (BYVAL nCount AS LONG, BYREF wszStr AS CONST WSTRING) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrRepeat(5, "Paul")

AfxStrReplace

Replaces all the occurrences of wszMatchStr in wszMainstr with the contents of wszReplaceWith. Case sensitive.

FUNCTION AfxStrReplace (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszMatchStr AS CONST WSTRING, BYREF wszReplaceWith AS CONST WSTRING) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrReplace("Hello World", "World", "Earth")   ' Returns "Hello Earth"

AfxStrReplaceI

Replaces all the occurrences of wszMatchStr in wszMainstr with the contents of wszReplaceWith. Case insensitive.

FUNCTION AfxStrReplaceI (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszMatchStr AS CONST WSTRING, BYREF wszReplaceWith AS CONST WSTRING) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrReplaceI("Hello world", "World", "Earth")   ' -> "Hello Earth"

AfxStrReplaceAny

Replaces all the occurrences of any of the individual characters wszMatchStr in wszMainstr with the contents of wszReplaceWith. wszReplaceWith must be a single character (this function does not replace words; therefore, wszMatchStr will not shrink or grow). Case sensitive.

FUNCTION AfxStrReplaceAny  (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszMatchStr AS CONST WSTRING, BYREF wszReplaceWith AS CONST WSTRING) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrReplaceAny("abacadabra", "bac", "*")   ' -> *****d**r*

AfxStrReplaceAnyI

Replaces all the occurrences of any of the individual characters wszMatchStr in wszMainstr with the contents of wszReplaceWith. wszReplaceWith must be a single character (this function does not replace words; therefore, wszMatchStr will not shrink or grow). Case insensitive.

FUNCTION AfxStrReplaceAnyI  (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszMatchStr AS CONST WSTRING, BYREF wszReplaceWith AS CONST WSTRING) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrReplaceAnyI("abacadabra", "BaC", "*")   ' -> *****d**r*

AfxStrRetain

Returns a string containing only the characters contained in a specified match string. Case sensitive.

FUNCTION AfxStrRetain (BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrRetain("abacadabra","b")   ' -> "bb"

AfxStrRetainI

Returns a string containing only the characters contained in a specified match string. Case insensitive.

FUNCTION AfxStrRetainI (BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrRetainI("abacadabra","B")   ' -> "bb"

AfxStrRetainAny

Returns a string containing only the characters contained in a specified group of characters. Case sensitive.

FUNCTION AfxStrRetainAny (BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrRetainAny("<p>1234567890<ak;lk;l>1234567890</p>", "<;/p>")

AfxStrRetainAnyI

Returns a string containing only the characters contained in a specified group of characters. Case insensitive.

FUNCTION AfxStrRetainAnyI (BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrRetainAnyI("<p>1234567890<ak;lk;l>1234567890</p>", "<;/P>")

AfxStrReverse

Reverses the contents of a string expression.

FUNCTION AfxStrReverse (BYREF wszMainStr AS CONST WSTRING) AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrReverse("garden")   ' Returns "nedrag"

AfxStrRSet

Returns a string containing a right justified string.

FUNCTION AfxStrRSet (BYREF wszMainStr AS CONST WSTRING, _
   BYVAL nStringLength AS LONG, BYREF wszPadCharacter AS CONST WSTRING = " ") AS CWSTR

Usage example

DIM cws AS CWSTR = AfxStrRSet("FreeBasic", 20, "*")

AfxStrShrink

Shrinks a string to use a consistent single character delimiter.

FUNCTION AfxStrShrink (BYREF wszMainStr AS CONST WSTRING, BYREF wszMask AS CONST WSTRING = " ") AS CWSTR

Remarks

This function creates a string with consecutive words separated by a consistent single character, making it easier to parse. If wszMask is not specified, all leading and trailing spaces are removed and all occurrences of two or more spaces are changed to a single space. If wszMask contains one or more characters to shrink, all the leading and trailing occurences of them are removes and all occurrences of one or more characters of the mask are replaced with the first character of the mask.

Usage example

DIM cws AS CWSTR = AfxStrShrink(",,, one , two     three, four,", " ,")  ' Returns "one two three four"

AfxStrSplit

Splits a string into tokens, which are sequences of contiguous characters separated by any of the characters that are part of delimiters.

FUNCTION AfxStrSplit (BYREF wszStr AS CONST WSTRING, BYREF wszDelimiters AS WSTRING = " ") AS CSafeArray

Return value

A CSafeArray containing a token in each element.

Usage example

DIM cws AS CWSTR = "- This, a sample string."
DIM cwsa AS CSafeArray = AfxStrSplit(cws, " ,.-")
FOR i AS LONG = cwsa.LBound TO cwsa.UBound
  PRINT cwsa.GetStr(i)
NEXT

Include file: CSafeArray.inc

AfxStrSpn

Returns the length of the initial portion of a string which consists only of characters that are part of a specified set of characters.

FUNCTION AfxStrSpn (BYREF wszText AS CONST WSTRING, BYREF wszSet AS CONST WSTRING) AS LONG

Usage example

DIM wszText AS WSTRING * 260 = "129th"
DIM wszSet AS WSTRING * 260 = "1234567890"
DIM n AS LONG = StrSpnW(@wszText, @wszSet)
printf(!"The initial number has %d digits.\n", n)

AfxStrTally

Count the number of occurrences of a string or a list of characters within a string. Case sensitive.

FUNCTION AfxStrTally (BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS LONG

Return value

The number of occurrences of wszMatchStr in wszMainStr.

Usage example

DIM nCount AS LONG = AfxStrTally("abacadabra", "ab")   ' Returns 2

AfxStrTallyI

Count the number of occurrences of a string or a list of characters within a string. Case insensitive.

FUNCTION AfxStrTallyI (BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS LONG

Return value

The number of occurrences of wszMatchStr in wszMainStr.

Usage example

DIM nCount AS LONG = AfxStrTallyI("abacadabra", "Ab")   ' -> 2

AfxStrTallyAny

Count the number of occurrences of a string or a list of characters within a string. Case sensitive.

FUNCTION AfxStrTallyAny (BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS LONG

Return value

The number of occurrences of wszMatchStr in wszMainStr.

Usage example

DIM nCount AS LONG = AfxStrTallyAny("abacadabra", "bac")   ' -> 8

AfxStrTallyAnyI

Count the number of occurrences of a string or a list of characters within a string. Case insensitive.

FUNCTION AfxStrTallyAnyI (BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS LONG

Return value

The number of occurrences of wszMatchStr in wszMainStr.

Usage example

DIM nCount AS LONG = AfxStrTallyAnyI("abacadabra", "bAc")   ' -> 8

AfxStrUCase

Returns an uppercased version of a string.

FUNCTION AfxStrUCase (BYVAL pwszStr AS WSTRING PTR, _
   BYVAL pwszLocaleName AS WSTRING PTR = LOCALE_NAME_USER_DEFAULT, _
   BYVAL dwMapFlags AS DWORD = 0) AS CWSTR

For a table of language culture names see: Table of Language Culture Names, Codes, and ISO Values

For a complete list see: LCMapStringEx function

Remarks

The string conversion functions available in FreeBasic are not fully suitable for some languages. For example, the Turkish word "karışıklığı" is uppercased as "KARıŞıKLıĞı" instead of "KARIŞIKLIĞI", and "KARIŞIKLIĞI" is lowercased to "karişikliği" instead of "karışıklığı". Notice the "ı", that is not an "i".

Return value

The uppercased string.

AfxStrUnWrap

Removes paired characters to the beginning and end of a string.

FUNCTION AfxStrUnWrap (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszLeftChar AS CONST WSTRING, BYREF wszRightChar AS CONST WSTRING) AS CWSTR

FUNCTION AfxStrUnWrap (BYREF wszMainStr AS CONST WSTRING, BYREF wszChar AS CONST WSTRING) AS CWSTR

Remarks

If only one wrap character/string is specified then that character or string is used for both sides. If no wrap character/string is specified then double quotes are used.

Usage examples

AfxStrUnWrap("<Paul>", "<", ">") results in Paul
AfxStrUnWrap("'Paul'", "'") results in Paul
AfxStrUnWrap("""Paul""") results in Paul

AfxStrVerify

Determine whether each character of a string is present in another string. Case sensitive.

FUNCTION AfxStrVerify (BYVAL nStart AS LONG, _
   BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS LONG

Return value

Returns zero if each character in wszMainStr is present in wszMatchStr; otherwise, it returns the position of the first non-matching character in wszMainStr. If nStart is zero, a negative number of a value greater that the length of wszMainstr, zero is returned.

Usage example

DIM nCount AS LONG = AfxStrVerify(5, "123.65,22.5", "0123456789")   ' Returns 7

Remark

Returns 7 since 5 starts it past the first non-digit "." at position 4.

AfxStrVerifyI

Determine whether each character of a string is present in another string. Case insensitive.

FUNCTION AfxStrVerifyI (BYVAL nStart AS LONG, _
   BYREF wszMainStr AS CONST WSTRING, BYREF wszMatchStr AS CONST WSTRING) AS LONG

Return value

Returns zero if each character in wszMainStr is present in wszMatchStr; otherwise, it returns the position of the first non-matching character in wszMainStr. If nStart is zero, a negative number of a value greater that the length of wszMainstr, zero is returned.

Usage example

DIM nCount AS LONG = AfxStrVerifyI(5, "123.65abcx22.5", "0123456789ABC")   ' -> 10

AfxStrWrap

Adds paired characters to the beginning and end of a string.

FUNCTION AfxStrWrap (BYREF wszMainStr AS CONST WSTRING, _
   BYREF wszLeftChar AS CONST WSTRING, BYREF wszRightChar AS CONST WSTRING) AS CWSTR

FUNCTION AfxStrWrap (BYREF wszMainStr AS CONST WSTRING, BYREF wszChar AS CONST WSTRING) AS CWSTR

Remarks

If only one wrap character/string is specified then that character or string is used for both sides. If no wrap character/string is specified then double quotes are used.

Usage examples

AfxStrWrap("Paul", "<", ">") results in <Paul>
AfxStrWrap("Paul", "'") results in 'Paul'
AfxStrWrap("Paul") results in "Paul"

AfxBase64DecodeA

Converts the contents of a Base64 mime encoded string to an ascii string.

FUNCTION AfxBase64DecodeA (BYREF strData AS STRING) AS STRING

Return value

The decoded string on success, or a null string on failure.

Remaks

Base64 is a group of similar encoding schemes that represent binary data in an ASCII string format by translating it into a radix-64 representation. The Base64 term originates from a specific MIME content transfer encoding.

Base64 encoding schemes are commonly used when there is a need to encode binary data that needs be stored and transferred over media that are designed to deal with textual data. This is to ensure that the data remains intact without modification during transport. Base64 is used commonly in a number of applications including email via MIME, and storing complex data in XML.

If we want to encode a unicode string, we must convert it to utf8 before calling AfxBase64EncodeA, e.g.

DIM cws AS CWSTR = "おはようございます – Good morning!"
DIM s AS STRING = AfxBase64EncodeA(cws.Utf8)

To decode it, we can use

DIM cwsOut AS CWSTR = CWSTR(AfxBase64DecodeA(s), CP_UTF8)

or

DIM cwsOut AS CWSTR
cws.utf8 = AfxBase64DecodeA(s)

AfxBase64DecodeW

Converts the contents of a Base64 mime encoded string to an unicode string.

FUNCTION AfxBase64DecodeW (BYREF cwsData AS CWSTR) AS CWSTR

Return value

The decoded string on success, or a null string on failure.

Remaks

Base64 is a group of similar encoding schemes that represent binary data in an ASCII string format by translating it into a radix-64 representation. The Base64 term originates from a specific MIME content transfer encoding.

Base64 encoding schemes are commonly used when there is a need to encode binary data that needs be stored and transferred over media that are designed to deal with textual data. This is to ensure that the data remains intact without modification during transport. Base64 is used commonly in a number of applications including email via MIME, and storing complex data in XML.

AfxBase64EncodeA

Converts the contents of an ascii string to Base64 mime encoding.

FUNCTION AfxBase64EncodeA (BYREF strData AS STRING) AS STRING

Return value

The encoded string on succeess, or a null string on failure.

Remarks

Base64 is a group of similar encoding schemes that represent binary data in an ASCII string format by translating it into a radix-64 representation. The Base64 term originates from a specific MIME content transfer encoding.

Base64 encoding schemes are commonly used when there is a need to encode binary data that needs be stored and transferred over media that are designed to deal with textual data. This is to ensure that the data remains intact without modification during transport. Base64 is used commonly in a number of applications including email via MIME, and storing complex data in XML.

If we want to encode a unicode string, we must convert it to utf8 before calling AfxBase64Encode, e.g.

DIM cws AS CWSTR = "おはようございます – Good morning!"
DIM s AS STRING = AfxBase64EncodeA(cws.Utf8)

To decode it, we can use

DIM cwsOut AS CWSTR = CWSTR(AfxBase64DecodeA(s), CP_UTF8)

or

DIM cwsOut AS CWSTR
cws.utf8 = AfxBase64DecodeA(s)

AfxBase64EncodeW

Converts the contents of an unicode string to Base64 mime encoding.

FUNCTION AfxBase64EncodWeA (BYREF cwsData AS CWSTR) AS CWSTR

Return value

The encoded string on succeess, or a null string on failure.

Remarks

Base64 is a group of similar encoding schemes that represent binary data in an ASCII string format by translating it into a radix-64 representation. The Base64 term originates from a specific MIME content transfer encoding.

Base64 encoding schemes are commonly used when there is a need to encode binary data that needs be stored and transferred over media that are designed to deal with textual data. This is to ensure that the data remains intact without modification during transport. Base64 is used commonly in a number of applications including email via MIME, and storing complex data in XML.

AfxCryptBinaryToString

Converts an array of bytes into a formatted string.

FUNCTION FUNCTION AfxCryptBinaryToStringA ( _
   BYVAL pbBinary AS CONST UBYTE PTR, _
   BYVAL cbBinary AS DWORD, _
   BYVAL dwFlags AS DWORD, _
   BYVAL pszString AS LPSTR, _
   BYVAL pcchString AS DWORD PTR _
) AS WINBOOL

FUNCTION AfxCryptBinaryToStringW ( _
   BYVAL pbBinary AS CONST UBYTE PTR, _
   BYVAL cbBinary AS DWORD, _
   BYVAL dwFlags AS DWORD, _
   BYVAL pszString AS LPWSTR, _
   BYVAL pcchString AS DWORD PTR _
) AS WINBOOL

Values available for the dwFlags parameter:

In addition to the values above, one or more of the following values can be specified to modify the behavior of the function.

Return value

If the function succeeds, the function returns nonzero (CTRUE). If the function fails, it returns zero (FALSE).

Remarks

With the exception of when CRYPT_STRING_BINARY encoding is used, all strings are appended with a new line sequence. By default, the new line sequence is a CR/LF pair (0x0D/0x0A). If the dwFlags parameter contains the CRYPT_STRING_NOCR flag, then the new line sequence is a LF character (0x0A). If the dwFlags parameter contains the CRYPT_STRING_NOCRLF flag, then no new line sequence is appended to the string.

AfxCryptStringToBinary

Converts a formatted string into an array of bytes.

FUNCTION AfxCryptStringToBinaryA ( _
   BYVAL pszString AS LPCSTR, _
   BYVAL cchString AS DWORD, _
   BYVAL dwFlags AS DWORD, _
   BYVAL pbBinary AS UBYTE PTR, _
   BYVAL pcbBinary AS DWORD PTR, _
   BYVAL pdwSkip AS DWORD PTR, _
   BYVAL pdwFlags AS DWORD PTR _
) AS WINBOOL

FUNCTION AfxCryptStringToBinaryW ( _
   BYVAL pszString AS LPCWSTR, _
   BYVAL cchString AS DWORD, _
   BYVAL dwFlags AS DWORD, _
   BYVAL pbBinary AS UBYTE PTR, _
   BYVAL pcbBinary AS DWORD PTR, _
   BYVAL pdwSkip AS DWORD PTR, _
   BYVAL pdwFlags AS DWORD PTR _
) AS WINBOOL

Values available for the dwFlags parameter:

Values available for the pdwFlags parameter: